Options générales¶

-C fichier, --config-file=fichier

Utilise le fichier de configuration indiqué au lieu du fichier ~/.manpath par défaut.

-d, --debug

Affiche les informations de mise au point.

-D, --default

Cette option est normalement utilisée en toute première option et réinitialise les comportements de man à leurs valeurs par défaut. Son utilisation réinitialise les options qui auraient pu être modifiées par les valeurs placées dans $MANOPT. Toutes les options qui suivent -D auront leur effet habituel.

--warnings[=avertissements]

Active les avertissements de groff. C'est utilisable pour réaliser des vérifications sur le texte source des pages de manuel. avertissements est une liste de noms d'avertissement séparés par des virgules ; si rien n'est fourni, la valeur par défaut est « mac ». Voir le nœud « Warnings » d'info groff pour une liste de noms d'avertissement disponibles.

Modes opératoires principaux¶

-f, --whatis

Équivalent à whatis. Affiche, si elle est disponible, une courte description de la page de manuel. Consultez whatis(1) pour obtenir des précisions.

-k, --apropos

Équivalent à apropos. Cherche la description courte des pages de manuel correspondant au mot-clé et affiche toutes celles qu'il trouve. Voir apropos(1) pour obtenir des précisions.

-K, --global-apropos

Recherche le texte dans toutes les pages de manuel. Il s'agit d'une recherche par force brute qui peut prendre un peu de temps ; si possible, vous devriez indiquer une section pour réduire le nombre de pages à prendre en considération. Les termes de la recherche peuvent être de simples chaînes (par défaut) ou des expressions rationnelles si l'option --regex est utilisée.

veuillez noter que la recherche est effectuée dans les sources des pages de manuel, pas dans les textes mis en forme, et que ceci pour générer des faux positifs en raison des commentaires contenus dans les sources. La recherche dans les textes mis en forme peut être plus lente.

-l, --local-file

Active le mode « local ». Formate et affiche les fichiers de manuels locaux plutôt que de rechercher parmi la collection de manuels du système. Chaque page de manuel indiqué en argument sera interprétée comme un fichier source nroff au format approprié. Aucun fichier « cat » n'est produit. Si un « - » apparaît comme argument, l'entrée standard est lue. Quand l'option -l n'est pas employée, et que man ne trouve pas la page demandée, avant d'afficher le message d'erreur, il essaie de faire comme si cette option avait été indiquée en utilisant le nom de la page demandée comme nom de fichier et en recherchant une correspondance exacte dans le répertoire actuel.

-w, --where, --path, --location

N'affiche pas la page de manuel mais affiche le ou les emplacements des fichiers source nroff qui auraient dû être formatés. Si l'option -a est aussi utilisée, affiche l'emplacement de tous les fichiers source correspondants aux critères.

-W, --where-cat, --location-cat

N'affiche pas la pages de manuel mais affiche le ou les emplacements des fichiers « cat » préformatés qui auraient dû être affichés. Si l'option -a est aussi utilisée, affiche l'emplacement de tous les fichiers cat préformatés correspondants aux critères.

Si -w et -W sont tout les deux utilisées, la source et le fichier formaté sont affichés en suivant, séparés par un espace. Si toutes les options -w, -W, et -a sont utilisées, fait de même pour toutes les correspondances.

-c, --catman

Cette option n'est pas d'un usage général et devrait seulement être utilisée par le programme catman.

-R encodage, --recode=encodage

Plutôt que de formater la page de manuel comme d'habitude, affiche le code source converti en encodage indiqué. Si vous connaissez déjà l'encodage du fichier source, vous pouvez aussi utiliser directement manconv(1). Cependant, cette option permet de convertir plusieurs pages de manuel vers un unique encodage sans devoir explicitement déclarer l'encodage de chacune, à condition qu'elles soient déjà installées dans une structure similaire à la hiérarchie des pages de manuel.

Veuillez utiliser man-recode(1) à la place pour convertir plusieurs pages de manuel car il a été conçu pour un traitement par lot qui est plus rapide.

Trouver des pages de manuel¶

-L locale, --locale=locale

man détermine habituellement la locale (NdT : la langue ou le dialecte) actuelle par un appel à la fonction C setlocale(3) qui consulte diverses variables d'environnement, y compris $LC_MESSAGES et $LANG. Pour remplacer temporairement la valeur définie, utilisez cette option. Elle fournit directement à man la chaîne de caractères représentant la locale. Notez que cette valeur ne prendra effet qu'à partir de la recherche des pages. Par conséquent, les autres affichages, tels que les messages d'aide, seront toujours montrés dans la langue initialement déterminée.

-m système[,...], --systems=système[,...]

Si le système a accès aux pages de manuel d'un autre système d'exploitation, celles-ci peuvent être consultées en utilisant cette option. Pour rechercher une page de manuel du système d'exploitation NouveauSE, employez l'option -m NouveauSE.

Le système mentionné peut être une succession de noms de systèmes d'exploitation, séparés par des virgules. Pour que la recherche ait lieu également sur le système d'exploitation natif, il faut inclure le nom système man dans la chaîne fournie en argument (NdT : il semble que le système natif soit inclus dans la recherche, même en l'absence de cette valeur). Cette option remplace la variable d'environnement $SYSTEM.

-M liste_de_chemins, --manpath=liste_de_chemins

Précise le chemin de recherche à utiliser. Par défaut, man se sert de manpath pour déterminer la liste des chemins d'accès aux structures hiérarchiques de pages de manuel. Cette option remplace la variable d'environnement $MANPATH et entraîne l'inefficience de l'option -m.

Chaque chemin indiqué avec cette option doit être la racine d'une hiérarchie de pages de manuel, structurée en sections, comme décrit dans le manuel de man-db, sous le titre « The manual page system ». Pour consulter des pages de manuel situées en dehors de telles structures hiérarchiques, utilisez l'option -l.

-S liste, -s liste, --sections=liste

La liste liste est une liste de sections séparés par des deux-points ou des virgules, utilisée pour déterminer dans quelles sections de manuel rechercher et suivant quel ordre. Cette option remplace la variable d'environnement $MANSECT (l'écriture -s existe par compatibilité avec System V).

-e sous-extension, --extension=sous-extension

Certains programmes installent un grand nombre de pages de manuel dans la structure hiérarchique principale des manuels, comme celles qui accompagnent le programme Tcl. Pour éviter d'avoir deux pages de manuel avec le même nom, comme exit(3), toutes les pages de manuel de Tcl étaient habituellement assignées à la section l. Comme ceci est maladroit, il est maintenant possible de mettre les pages dans la bonne section, et de leur assigner une extension spécifique. Dans le cas présent exit(3tcl). En fonctionnement normal, man affichera exit(3) de préférence à exit(3tcl). Pour gérer cette situation et éviter d'avoir à connaître la section où se trouve la page désirée, il est maintenant possible de donner à man une chaîne de sous-extension indiquent à quel programme la page appartient. Avec l'exemple ci-dessus, l'emploi de l'option -e tcl limitera la recherche aux pages ayant une extension *tcl.

-i, --ignore-case

Ignore la casse lors de la recherche de la page de manuel. C'est le comportement par défaut.

-I, --match-case

Cherche la page de manuel en tenant compte de la casse.

--regex

Montre toutes les pages ayant une partie de leur nom ou description qui correspond à chaque argument page en tant qu'expression rationnelle, comme avec apropos(1). Puisqu'il n'existe pas de façon raisonnable de choisir une « meilleure » page lors d'une recherche d'expression rationnelle, cette option induit -a.

--wildcard

Montre toutes les pages ayant une partie de leur nom ou description qui correspond à chaque argument page en utilisant des jokers (wildcards), comme avec apropos(1) --wildcard. L'argument page doit correspondre à la totalité du nom ou de la description, ou aux frontières de mot de la description. Puisqu'il n'existe pas de façon raisonnable de choisir une « meilleure » page lors d'une recherche de joker, cette option induit -a.

--names-only

Si une des options --regex ou --wildcard est utilisée, correspond seulement aux noms de pages, pas aux descriptions, comme avec whatis(1), sans effet sinon.

-a, --all

Par défaut, man s'arrêtera après avoir affiché la page de manuel la plus appropriée trouvée. L'emploi de cette option force man à afficher toutes les pages de manuel dont les noms satisfont les critères de recherche.

-u, --update

Cette option force man à mettre à jour ses caches et installer les pages de manuel. Ceci ne devrait être nécessaire que rarement. À l'ordinaire utilsez de préférence mandb(8).

--no-subpages

Par défaut, man essaiera d'interpréter une paire de noms de page de manuel donnés sur la ligne de commande comme s'il s'agissait d'un seul nom de page de manuel contenant un tiret ou un tiret bas. Cela prend en charge le motif habituel des programmes avec plusieurs sous-commandes, leur permettant de fournir une page de manuel pour chacune accessible avec une syntaxe similaire à celle utilisée pour appeler les sous-commandes. Par exemple :

  $ man -aw git diff
  /usr/share/man/man1/git-diff.1.gz

Pour désactiver ce comportement, utilisez l'option --no-subpages :

  $ man -aw --no-subpages git diff
  /usr/share/man/man1/git.1.gz
  /usr/share/man/man3/Git.3pm.gz
  /usr/share/man/man1/diff.1.gz

Contrôle du format d'affichage¶

-P afficheur, --pager=afficheur

Précise l'afficheur à utiliser. Par défaut, man utilise less, à moins que less ne soit pas défini ou exécutable auquel cas cat est utilisé. Cette option remplace la variable d'environnement $MANPAGER, elle-même remplaçant la variable d'environnement $PAGER. Elle n'est pas utilisable avec -f ou -k.

La valeur peut être juste un nom de commande ou une commande avec des arguments, et peut utiliser les protections de l'interpréteur (contre-obliques, guillemets simples ou doubles). L'utilisation de tubes pour relier plusieurs commandes n'est pas possible ; si vous en avez vraiment besoin, utilisez un script enveloppe qui pourra prendre en argument le fichier à afficher ou l'entrée standard.

-r invite, --prompt=invite

Si une version récente de less est utilisée comme afficheur, man tentera de régler l'invite ainsi que d'autres options. L'invite par défaut ressemble à :

Manual Page nom(section) line x

dans laquelle nom représente le nom de la page de manuel, section le numéro de section où la page a été trouvée et x le numéro de la ligne actuelle. C'est réalisé en utilisant la variable d'environnement $LESS.

Fournir -r avec une chaîne écrasera ce comportement par défaut. La chaîne indiquée peut contenir la variable de substitution $MAN_PN qui sera remplacée par le nom de la page de manuel affichée, accompagnée de son numéro de section, entouré par « ( » et « ) ». La chaîne employée pour obtenir la valeur par défaut ressemble à :

\ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%..
(tapez h pour l'aide ou q pour quitter)

Cette chaîne a été coupée en trois lignes, ici, uniquement pour des raisons de lisibilité. Pour sa signification, consultez la page de manuel de less(1). La chaîne de caractères est d'abord évaluée par l'interpréteur de commandes. Tous les guillemets, apostrophes inversées et contre-obliques (antislash) devant apparaître dans l'invite doivent être précédés du caractère de protection « \ ». La chaîne de caractères de l'invite peut se terminer par un « $ » protégé qui peut être suivi d'autres options de less. Par défaut, man utilise l'option -ix8.

La variable d'environnement $MANLESS décrite ci-dessous peut être utilisée pour définir une chaîne d’invite par défaut si aucune n’est fournie sur la ligne de commande.

-7, --ascii

En visualisant une page de manuel en ascii(7) pur, sur un terminal 7 bits ou sur un émulateur de terminal, certains caractères peuvent ne pas être affichés correctement lors de l'utilisation d'un descripteur de périphérique latin1(7) avec GNU nroff. Cette option permet aux pages de manuel en ascii pur d'être affichées en ascii sur des périphériques latin1. Il n'y aura pas de traduction du texte en latin1. La table ci-dessous montre les traductions effectuées. Certains éléments de cette table ne peuvent être affichés correctement qu'en utilisant un périphérique latin1 conforme à GNU nroff.

Description	Octal	latin1	ascii
trait d'union	255	‐	-
point médian	267	•	o
accent aigu	264	´	'
symbole de multiplication	327	×	x

Si la colonne latin1 est affichée correctement, votre terminal peut être exploité avec les caractères latin1 et cette option est inutile. Si les colonnes latin1 et ascii sont identiques, soit vous avez utilisé cette option, soit man n'a pas formaté cette page en utilisant le descripteur de périphérique latin1. Si la colonne latin1 est absente ou altérée, vous devriez utilisez cette option.

Cette option est ignorée lors de l'usage des options -t, -H, -T, ou -Z et peut être omise pour les nroff autres que ceux du GNU.

-E encodage, --encoding=encodage

Produit une sortie avec un encodage de caractères autre que celui par défaut. Pour des raisons de compatibilité ascendante, encodage peut être un périphérique nroff tel que ascii, latin1, ou utf8 ainsi qu'une réelle valeur d'encodage comme UTF-8.

--no-hyphenation, --nh

Normalement, nroff place un trait d'union lorsque les lignes sont coupées même si les mots n'en contiennent pas, s'il est nécessaire de le faire pour arranger les mots sur une ligne sans espacements excessifs. Cette option désactive la césure automatique, et les mots ne seront coupés que s'il contiennent déjà un trait d'union.

Pour éviter à nroff de couper un mot au mauvais endroit quand vous écrivez une page de manuel, n'utilisez pas cette option, mais consultez plutôt la documentation de nroff. Par exemple, vous pouvez placer « \% » dans un mot pour indiquer qu'il peut être coupé à cet endroit, ou « \% » au début d'un mot pour l'empêcher d'être coupé.

--no-justification, --nj

Normalement, nroff justifie automatiquement le texte. Cette option désactive la justification, laissant le texte aligné (ou « ferré ») à droite, aussi appelé « drapeau gauche ».

Pour éviter à nroff de justifier certains paragraphes quand vous écrivez une page de manuel, n'utilisez pas cette option, mais consultez plutôt la documentation de nroff. Par exemple, vous pouvez utiliser les requêtes « .na », « .nf », « .fi » et « .ad » pour désactiver temporairement le réglage et le remplissage.

-p chaîne, --preprocessor=chaîne

Indique la liste des préprocesseurs à utiliser avant nroff, troff ou groff. Toutes les implémentations ne disposent pas du jeu complet de préprocesseurs. Voici une liste de certains préprocesseurs, avec les lettres les désignant : eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Cette option remplace la variable d'environnement $MANROFFSEQ. zsoelim est toujours exécuté comme le tout premier préprocesseur.

-t, --troff

Utilise groff -mandoc pour mettre en forme la page de manuel sur la sortie standard. Cette option n'est pas nécessaire avec -H, -T, ou -Z.

-T[périphérique], --troff-device[=périphérique]

Cette option est utilisée pour modifier ce qui est produit par groff (ou éventuellement par troff) afin d'être exploitable par un périphérique autre que le périphérique par défaut. Cette option implique l'option -t. Exemples de périphériques (fournis avec Groff-1.17) : dvi, latin1, ps, utf8, X75 et X100.

-H[navigateur], --html[=navigateur]

Cette option fera produire à groff une page au format HTML qui sera ensuite affichée dans un navigateur web. Le choix du navigateur est déterminé soit par l'argument optionnel navigateur, s'il est indiqué, soit par la variable d'environnement $BROWSER ou sinon par la valeur par défaut indiquée lors de la compilation (habituellement lynx). Cette option induit -t et ne fonctionne qu'avec les troff GNU.

-X[ppp], --gxditview[=ppp]

Cette option affiche la sortie de groff dans une fenêtre graphique en utilisant le programme gxditview. Le ppp (points par pouce) peut être 75 (par défaut), 75-12, 100 ou 100-12. La variante « -12 » utilise une fonte de 12 points. Cette option induit -T avec comme périphérique respectif X75, X75-12, X100 ou X100-12.

-Z, --ditroff

groff exécutera troff puis utilisera le postprocesseur approprié afin de produire une sortie exploitable par le périphérique choisi. Si groff -mandoc est groff alors cette option sera passée à groff et aucun postprocesseur ne sera exécuté. Cette option induit -t.

Obtenir de l'aide¶

-?, --help

Affiche un message d'aide et s'arrête.

--usage

Affiche un court mode d'emploi et s'arrête.

-V, --version

Affiche le numéro de version.